/config/app/proxy/forwardProxy//description

Create a description for the forward proxy.

Use

Use to create a description of the forward proxy use and any other information.

Parameters

name: Name of forward proxy object

Data Key

The data key contains the description.

Note: When the default key is set to true, it means the object is set to its default. In this case, the system works as follows:

• On a PUT operation, the system ignores the data key. (Applicable only to /config nodes.)
• On a GET operation, the response only contains “default”: True and does not contain the data key.
• If the object has a base, it inherits its setting from its base.

See [Setting Objects to Their Default](https://docs.lineratesystems.com/093Rel ease_2.5/250REST_API_Reference_Guide/000Getting_Started_with_the_REST_API/300U nderstanding_the_REST_Hierarchy#Setting_Objects_to_Their_Default_(Default_Key) ).

Data Type

string

Default Data Value

“”

An object uses the default data value when one of the following is true:

• For objects without bases–When the object’s default key is true.
• For objects with bases–When the object’s default key is true, and when the default key is true for all of the object’s bases.

Default Allowed

False

Request Methods

GET, PUT

Related

REST API Reference - [/config/app/proxy/forwardProxy](https://docs.lineratesys tems.com/093Release_2.5/250REST_API_Reference_Guide/config/app/proxy/forwardPr oxy)

CLI Reference - [Forward Proxy Mode Commands](https://docs.lineratesystems.com /093Release_2.5/200CLI_Reference_Guide/Configure_Commands/Forward_Proxy_Mode_C ommands)

Examples

GET

curl -b cookie.jar -k https://host-117:8443/lrs/api/v1.0/config/app/proxy/forw ardProxy/fp-01/description

GET Response

{"/config/app/proxy/forwardProxy/fp-01/description": {"data": "",
                                                       "default": False,
                                                       "defaultAllowed": False,
                                                       "deleteAllowed": False,
                                                       "numChildren": 0,
                                                       "type": "string"},
 "httpResponseCode": 200,
 "recurse": False,
 "requestPath": "/config/app/proxy/forwardProxy/fp-01/description"}

PUT

curl -b cookie.jar –data @data.json -k -H “Content-Type: application/json” -X PUT https://host-117:8443/lrs/api/v1.0/config/app/proxy/forwardProxy/fp-01/des cription

PUT Response

{"httpResponseCode": 200,
  "requestPath": "/config/app/proxy/forwardProxy/fp-01/description",
  "recurse":false}

1. /config/app/proxy/forwardProxy//description 1. Parameters 2. Data Key
   1. Data Type
   2. Default Data Value 3. Default Allowed 4. Request Methods 5. Related 6. Examples